Skip to content

Docs: Fix testing in CI rendering issues#35374

Open
jonniebigodes wants to merge 1 commit into
nextfrom
docs_fix_testing_ci_rendering_issues
Open

Docs: Fix testing in CI rendering issues#35374
jonniebigodes wants to merge 1 commit into
nextfrom
docs_fix_testing_ci_rendering_issues

Conversation

@jonniebigodes

@jonniebigodes jonniebigodes commented Jul 5, 2026

Copy link
Copy Markdown
Contributor

Closes #

What I did

With this pull request, the CI testing documentation was updated to fix a rendering issue with the GitHub Actions details element by adding a line break between the element and the text.

What was done:

  • Added a new line in the summary to allow the details element to render correctly.

Checklist for Contributors

Testing

The changes in this PR are covered in the following automated tests:

  • stories
  • unit tests
  • integration tests
  • end-to-end tests

Manual testing

This is a documentation-only change; no manual testing is required, but if anyone feels adventurous, check the published documentation and compare it against this change

Caution

This section is mandatory for all contributions. If you believe no manual test is necessary, please state so explicitly. Thanks!

Documentation

  • Add or update documentation reflecting your changes
  • If you are deprecating/removing a feature, make sure to update
    MIGRATION.MD

Checklist for Maintainers

  • When this PR is ready for testing, make sure to add ci:normal, ci:merged or ci:daily GH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found in code/lib/cli-storybook/src/sandbox-templates.ts

  • Declare whether manual QA will be needed for this PR during the next release, through qa:needed or qa:skip

  • Make sure this PR contains one of the labels below:

    Available labels
    • bug: Internal changes that fixes incorrect behavior.
    • maintenance: User-facing maintenance tasks.
    • dependencies: Upgrading (sometimes downgrading) dependencies.
    • build: Internal-facing build tooling & test updates. Will not show up in release changelog.
    • cleanup: Minor cleanup style change. Will not show up in release changelog.
    • documentation: Documentation only changes. Will not show up in release changelog.
    • feature request: Introducing a new feature.
    • BREAKING CHANGE: Changes that break compatibility in some way with current major version.
    • other: Changes that don't fit in the above categories.

🦋 Canary release

This PR does not have a canary release associated. You can request a canary release of this pull request by mentioning the @storybookjs/core team here.

core team members can create a canary release here or locally with gh workflow run --repo storybookjs/storybook publish.yml --field pr=<PR_NUMBER>

Summary by CodeRabbit

  • Documentation
    • Updated the testing guide with a small formatting improvement in the CI workflow section for easier reading.

@jonniebigodes jonniebigodes self-assigned this Jul 5, 2026
@jonniebigodes jonniebigodes requested a review from kylegach as a code owner July 5, 2026 18:00
@jonniebigodes jonniebigodes added documentation ci:docs Run the CI jobs for documentation checks only. qa:skip Pull Requests that do not need any QA. labels Jul 5, 2026
@coderabbitai

coderabbitai Bot commented Jul 5, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: a418e903-86ca-4803-8dc3-afb2fe2b153c

📥 Commits

Reviewing files that changed from the base of the PR and between fac05a5 and dd62ec3.

📒 Files selected for processing (1)
  • docs/writing-tests/in-ci.mdx

📝 Walkthrough

Walkthrough

A single blank line was added to the docs/writing-tests/in-ci.mdx file within the GitHub Actions subsection under "Add a new CI workflow." This is a formatting-only change with no content or code modifications.

Changes

Documentation Formatting

Layer / File(s) Summary
Blank line addition
docs/writing-tests/in-ci.mdx
A single blank line was added within the GitHub Actions details block.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Estimated code review effort: 1 (Trivial) | ~2 minutes


Comment @coderabbitai help to get the list of available commands.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ci:docs Run the CI jobs for documentation checks only. documentation qa:skip Pull Requests that do not need any QA.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant